<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /**<a name="line.1"></a>
<FONT color="green">002</FONT>     * Hackystat Version 8 Framework<a name="line.2"></a>
<FONT color="green">003</FONT>     * Twitter Widget RPC Interface<a name="line.3"></a>
<FONT color="green">004</FONT>     */<a name="line.4"></a>
<FONT color="green">005</FONT>    package org.hackystat.ui.telemetryviewer.client.common;<a name="line.5"></a>
<FONT color="green">006</FONT>    <a name="line.6"></a>
<FONT color="green">007</FONT>    import java.util.ArrayList;<a name="line.7"></a>
<FONT color="green">008</FONT>    <a name="line.8"></a>
<FONT color="green">009</FONT>    import com.google.gwt.user.client.rpc.RemoteService;<a name="line.9"></a>
<FONT color="green">010</FONT>    <a name="line.10"></a>
<FONT color="green">011</FONT>    /**<a name="line.11"></a>
<FONT color="green">012</FONT>     * Remote procedure call interface for communicating with the Twitter server. <a name="line.12"></a>
<FONT color="green">013</FONT>     * <a name="line.13"></a>
<FONT color="green">014</FONT>     * @author David J. Nickles<a name="line.14"></a>
<FONT color="green">015</FONT>     */<a name="line.15"></a>
<FONT color="green">016</FONT>    public interface RPCRemoteService extends RemoteService {<a name="line.16"></a>
<FONT color="green">017</FONT>    <a name="line.17"></a>
<FONT color="green">018</FONT>      /**<a name="line.18"></a>
<FONT color="green">019</FONT>       * This method yields a name and general description for each of the available charts.<a name="line.19"></a>
<FONT color="green">020</FONT>       * @param session the host and user attributes.<a name="line.20"></a>
<FONT color="green">021</FONT>       * @return BasicConveyor carrying the chart names and descriptions.<a name="line.21"></a>
<FONT color="green">022</FONT>       */<a name="line.22"></a>
<FONT color="green">023</FONT>      public BasicConveyor getCharts(Session session);<a name="line.23"></a>
<FONT color="green">024</FONT>      <a name="line.24"></a>
<FONT color="green">025</FONT>      /**<a name="line.25"></a>
<FONT color="green">026</FONT>       * Return a detailed description of the chart definition.<a name="line.26"></a>
<FONT color="green">027</FONT>       * @param session the host and user attributes.<a name="line.27"></a>
<FONT color="green">028</FONT>       * @param chart the name of the requested chart.<a name="line.28"></a>
<FONT color="green">029</FONT>       * @return String Description of the requested sensor data.<a name="line.29"></a>
<FONT color="green">030</FONT>       */<a name="line.30"></a>
<FONT color="green">031</FONT>      public BasicConveyor getChartDefinition(Session session, String chart);<a name="line.31"></a>
<FONT color="green">032</FONT>     <a name="line.32"></a>
<FONT color="green">033</FONT>      /**<a name="line.33"></a>
<FONT color="green">034</FONT>       * Return the telemetry data set for a chart service.<a name="line.34"></a>
<FONT color="green">035</FONT>       * @param session the session attributes.<a name="line.35"></a>
<FONT color="green">036</FONT>       * @param chart the name of the requested chart.<a name="line.36"></a>
<FONT color="green">037</FONT>       * @param params the list of chart parameters.<a name="line.37"></a>
<FONT color="green">038</FONT>       * @param start XML formatted timestamp for beginning of data interval.<a name="line.38"></a>
<FONT color="green">039</FONT>       * @param end XML formatted timestamp for end of data interval.<a name="line.39"></a>
<FONT color="green">040</FONT>       * @return DatasetConveyor the requested telemetry data.<a name="line.40"></a>
<FONT color="green">041</FONT>       */<a name="line.41"></a>
<FONT color="green">042</FONT>      public DatasetConveyor getChartData(Session session, String chart, String params, <a name="line.42"></a>
<FONT color="green">043</FONT>        String start, String end);<a name="line.43"></a>
<FONT color="green">044</FONT>        <a name="line.44"></a>
<FONT color="green">045</FONT>      /**<a name="line.45"></a>
<FONT color="green">046</FONT>       * This method retrieves the host uris for the Sensorbase and Telemetry services from the<a name="line.46"></a>
<FONT color="green">047</FONT>       * Telemetry Viewer properties file.<a name="line.47"></a>
<FONT color="green">048</FONT>       * <a name="line.48"></a>
<FONT color="green">049</FONT>       * @return BasicConveyor carrying the host uris for the Sensorbase and Telemetry services from<a name="line.49"></a>
<FONT color="green">050</FONT>       * the Telemetry Viewer properties file.<a name="line.50"></a>
<FONT color="green">051</FONT>       */<a name="line.51"></a>
<FONT color="green">052</FONT>      public BasicConveyor getHosts(); <a name="line.52"></a>
<FONT color="green">053</FONT>    <a name="line.53"></a>
<FONT color="green">054</FONT>      /**<a name="line.54"></a>
<FONT color="green">055</FONT>       * Returns true if the user and password is registered as a user with this host.<a name="line.55"></a>
<FONT color="green">056</FONT>       * @param session the host and user attributes.<a name="line.56"></a>
<FONT color="green">057</FONT>       * @return Boolean indicating if the user and password are valid in the sensorbase<a name="line.57"></a>
<FONT color="green">058</FONT>       */<a name="line.58"></a>
<FONT color="green">059</FONT>      public Boolean isRegistered(Session session);<a name="line.59"></a>
<FONT color="green">060</FONT>    <a name="line.60"></a>
<FONT color="green">061</FONT>      /**<a name="line.61"></a>
<FONT color="green">062</FONT>       * Registers the user with this host.<a name="line.62"></a>
<FONT color="green">063</FONT>       * <a name="line.63"></a>
<FONT color="green">064</FONT>       * @param host the URI for the SensorBase<a name="line.64"></a>
<FONT color="green">065</FONT>       * @param user user to authentication<a name="line.65"></a>
<FONT color="green">066</FONT>       * @return Boolean indicating if the user and password are valid in the sensorbase<a name="line.66"></a>
<FONT color="green">067</FONT>       */<a name="line.67"></a>
<FONT color="green">068</FONT>      public Boolean registerUser(String host, String user);<a name="line.68"></a>
<FONT color="green">069</FONT>    <a name="line.69"></a>
<FONT color="green">070</FONT>      /**<a name="line.70"></a>
<FONT color="green">071</FONT>       * Returns true if the passed host is a Telemetry Analysis service host.<a name="line.71"></a>
<FONT color="green">072</FONT>       * <a name="line.72"></a>
<FONT color="green">073</FONT>       * @param host the URI for the Telemetry service.<a name="line.73"></a>
<FONT color="green">074</FONT>       * @return Boolean indicating if the host is a valid Telemetry Analysis service.<a name="line.74"></a>
<FONT color="green">075</FONT>       */<a name="line.75"></a>
<FONT color="green">076</FONT>      public Boolean isTelemetryHost(String host);<a name="line.76"></a>
<FONT color="green">077</FONT>    <a name="line.77"></a>
<FONT color="green">078</FONT>      /**<a name="line.78"></a>
<FONT color="green">079</FONT>       * Returns true if the passed host is a DPD Analysis service host.<a name="line.79"></a>
<FONT color="green">080</FONT>       * <a name="line.80"></a>
<FONT color="green">081</FONT>       * @param host the URI for the DPD service.<a name="line.81"></a>
<FONT color="green">082</FONT>       * @return Boolean indicating if the host is a valid DPD Analysis service.<a name="line.82"></a>
<FONT color="green">083</FONT>       */<a name="line.83"></a>
<FONT color="green">084</FONT>      public Boolean isDPDHost(String host);<a name="line.84"></a>
<FONT color="green">085</FONT>    <a name="line.85"></a>
<FONT color="green">086</FONT>      /**<a name="line.86"></a>
<FONT color="green">087</FONT>       * Returns true if the passed host is a SensorBase service host.<a name="line.87"></a>
<FONT color="green">088</FONT>       * <a name="line.88"></a>
<FONT color="green">089</FONT>       * @param host the URI for the SensorBase.<a name="line.89"></a>
<FONT color="green">090</FONT>       * @return Boolean indicating if the host is a valid SensorBase service.<a name="line.90"></a>
<FONT color="green">091</FONT>       */<a name="line.91"></a>
<FONT color="green">092</FONT>      public Boolean isSensorBaseHost(String host);<a name="line.92"></a>
<FONT color="green">093</FONT>      <a name="line.93"></a>
<FONT color="green">094</FONT>      /**<a name="line.94"></a>
<FONT color="green">095</FONT>       * Returns the attributes set in the Manifest file.<a name="line.95"></a>
<FONT color="green">096</FONT>       * <a name="line.96"></a>
<FONT color="green">097</FONT>       * @return BasicConveyor containing a map of the attribute values from the Manifest file.<a name="line.97"></a>
<FONT color="green">098</FONT>       */<a name="line.98"></a>
<FONT color="green">099</FONT>      public BasicConveyor getManifest(); <a name="line.99"></a>
<FONT color="green">100</FONT>      <a name="line.100"></a>
<FONT color="green">101</FONT>      /**<a name="line.101"></a>
<FONT color="green">102</FONT>       * Return a formatted description of the requested sensor data on the specified interval.<a name="line.102"></a>
<FONT color="green">103</FONT>       * @param session the host and user attributes.<a name="line.103"></a>
<FONT color="green">104</FONT>       * @param year of interval<a name="line.104"></a>
<FONT color="green">105</FONT>       * @param month of interval<a name="line.105"></a>
<FONT color="green">106</FONT>       * @return Boolean array of days with data<a name="line.106"></a>
<FONT color="green">107</FONT>       * <a name="line.107"></a>
<FONT color="green">108</FONT>       * @gwt.typeArgs &lt;java.lang.Boolean&gt;<a name="line.108"></a>
<FONT color="green">109</FONT>       */<a name="line.109"></a>
<FONT color="green">110</FONT>      public ArrayList getOverview(Session session, int year, int month);<a name="line.110"></a>
<FONT color="green">111</FONT>    <a name="line.111"></a>
<FONT color="green">112</FONT>      /**<a name="line.112"></a>
<FONT color="green">113</FONT>       * Returns the index of all Projects from this server for this user.<a name="line.113"></a>
<FONT color="green">114</FONT>       * @param session host and user information.<a name="line.114"></a>
<FONT color="green">115</FONT>       * @return Returns the index of all Projects from this server for this user.<a name="line.115"></a>
<FONT color="green">116</FONT>       */<a name="line.116"></a>
<FONT color="green">117</FONT>      public ProjectConveyor getProjects(Session session);<a name="line.117"></a>
<FONT color="green">118</FONT>    <a name="line.118"></a>
<FONT color="green">119</FONT>      /**<a name="line.119"></a>
<FONT color="green">120</FONT>       * Logs the message from the javascript client.<a name="line.120"></a>
<FONT color="green">121</FONT>       * <a name="line.121"></a>
<FONT color="green">122</FONT>       * @param text message to log.<a name="line.122"></a>
<FONT color="green">123</FONT>       */<a name="line.123"></a>
<FONT color="green">124</FONT>      public void logClient(String text);<a name="line.124"></a>
<FONT color="green">125</FONT>    }<a name="line.125"></a>




























































</PRE>
</BODY>
</HTML>
